The Create Object contains JSON passed to the Payment Broker end–point above in order to create a URL to process a payment on the Payment Gateway.
The Create child objects are documented below and contain JSON to: authorise a merchant's request to the Payment Gateway; post a request to the Payment Gateway payments page to process a successful credit–card payment and respond appropriately via the Webhooks interface; and finally manage the validity period of the Payment Broker URL.
For a sample of a fully–functional JSON request see Figure 4. Connect.Create Response JSON Sample.
The Payment Broker responds with a fully–qualified URL that can be shared with the customer that provides the entry–point to the Payment Gateway at a future time for the specified merchant, product, and amount requested (see Connect.Create RESPONSE Object).
| Field Name | Type (max length) |
Required MandatoryOptional |
Description |
|---|---|---|---|
| Auth | Object | M |
The Authorisation object to verify a valid Payment Gateway merchant is permitted to request a URL to the payments page. SeeTable 8. Connect.Create.Authorisation Object Fields |
| Form | Object | M |
The Form object contains the data necessary to complete a valid credit–card payment on the payments page and respond back to the merchant with the outcome. SeeTable 9. Connect.Create.Form Object Fields |
| Expiry | Object | M |
The Expiry object contains the data to in-validate the URL provided by this service depending on parameters specified by the merchant. SeeTable 12. Connect.Create.Expiry Object Fields The URL is automatically expired once a successful payment is complete. |
| Field Name | Type (max length) |
Required Mandatory Optional |
Description |
|---|---|---|---|
| SupplierID ^ | String | M | This is the VPG assigned merchant identifier. The SupplierID field value will be submitted as SupplierAlias which are synonymous. e.g. "VC Upfront Payments" Will be provided by VFS after merchant on–boarding. |
| PayServerUser ^ | String | M | Merchant Technical users account username provided by Payment Gateway. Will be provided by VFS after merchant on–boarding. |
| PayServerPassword ^ | String | M | Merchant Technical users account password provided by Payment Gateway. Will be provided by VFS after merchant on–boarding. |
| Key | String | O | For Internal Use Only |